Skip to main content
GET
/
v1
/
system
/
userRoles
/
{type}
/
{id}
Get one User Role
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/system/userRoles/{type}/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "OrganizationUserRole",
    "id": 3,
    "name": "Administrators",
    "permissions": [
      "warehouse",
      "warehouse/staff",
      "warehouse/staff/time_entry_log",
      "warehouse/staff/time_management",
      "warehouse/staff/time_management/excluded",
      "warehouse/staff/time_management/status_dashboard"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
ā€‹
id
integer<int32>
required

The id of the referenced UserRole.

Required range: x >= 1

Response

OK

ā€‹
resource
OrganizationUserRole Ā· object

An OrganizationUserRole is used to provide a specific set of permissions to an organization's user.